home *** CD-ROM | disk | FTP | other *** search
/ CU Amiga Super CD-ROM 21 / CU Amiga Magazine's Super CD-ROM 21 (1998)(EMAP Images)(GB)[!][issue 1998-04].iso / CUCD / Programming / Candy / EZ-UU / VORTEX.doc < prev    next >
Encoding:
Text File  |  1997-09-01  |  51.1 KB  |  1,454 lines

  1.                 ______
  2.                /  /  /
  3.               /  /  /
  4.              /  /  /
  5. ______      /  /  / ________   _______   _________  _______  ____    ____
  6. \  \  \    /  /  / |        | |       \ |         ||       | \   \  /   /
  7.  \  \  \  /  /  /  |   __   | |   __   ||___   ___||   ____|  \   \/   /
  8.   \  \  \/  /  /   |  |  |  | |  |__|  |    | |    |  |____    \      /
  9.    \  \ /  /  /    |  |__|  | |   __  <     | |    |   ____|   /      \
  10.     \  /  /  /     |        | |  |  \  \    | |    |  |____   /   /\   \
  11.      \/_ /__/      |________| |__|   \__\   |_|    |_______| /___/  \___\
  12.  
  13.                  
  14.                  "A new dimension in Amiga file handling"
  15.  
  16.  
  17.                                 Version 1.0
  18.                         A program by: Joey McDonald
  19.  
  20.  
  21. NOTE: ONLINE DOCUMENTATION:
  22. ---------------------------
  23. This document may be accessed while running Vortex (the document
  24. must reside in the same directory that Vortex was started from). The
  25. section of the document regarding the current module/area of Vortex
  26. you are in will be located automatically.
  27.  
  28. If you are on the MAIN Vortex screen: Press SHIFT/HELP
  29. If you are on ANY OTHER Vortex screen: Press HELP.
  30.  
  31. Example: If you have the Split options window open and don't fully
  32. understand the options... Pressing the HELP key will automatically
  33. load this document and take you to the section regarding the split
  34. options.
  35.  
  36. =============
  37. Special Note:
  38. =============
  39.  
  40. Vortex is dedicated to my late grandfather.. Alfred McDaniel.
  41. He raised me as his son... and I will never forget him.
  42.  
  43. Love,
  44.  
  45. Joey McDonald
  46. -------------
  47.  
  48.  ============================ DISTRIBUTION: ===============================
  49.  
  50.  You may distribute Vortex via ANY means possible. The Only
  51.  restrictions:
  52.  
  53.  All files in this archive must be kept together when being
  54.  distributed.. and the files may not be altered in any way.
  55.  Also, any purely commercial venture (such as magazine coverdisk
  56.  inclusion) where the program is being "sold".. is not allowed
  57.  without first obtaining my permission.
  58.  
  59.  That's it! Follow that simple rule and you can give Vortex to
  60.  anybody.. via any means you'd like :)
  61.  
  62.   =========================== CONTRIBUTION: ==============================
  63.  
  64.   I'm only asking $1-$5 for Vortex. Surely.. if you like Vortex
  65.   you can afford to send at LEAST $1. I'd rather receive SOMETHING
  66.   for my work than NOTHING :)
  67.   
  68.   The contribution is completely optional. If you hate the
  69.   program I wouldn't expect you to send me anything :) BUT if
  70.   you like Vortex ... please think about the contribution.
  71.  
  72. SEND TO:
  73.   
  74. Joey McDonald
  75. 2627 S. Lamb Blvd. #205
  76. Las Vegas, NV 89121
  77. USA
  78.  
  79. Send Comments, Suggestion, or bug reports to:
  80.  
  81. tron@mclv.net
  82.  
  83.  
  84. Thanks for using Vortex.... I hope you like it!
  85.  
  86. Final Note on CONTRIBUTING:
  87.  
  88. I don't know how many times I've downloaded a GUI to a CLI
  89. program.. and the author is asking $10-$25. Add that amount
  90. to what the author of the CLI program may be asking and you've
  91. got a fairly substantial amount.
  92.  
  93. In the case of Vortex, it's a stand alone program in many
  94. respects (it has features that work independent of external
  95. programs) and is also 5 or 6 GUI's rolled into one. Rather
  96. than ask an outrageous amount (which I feel $25 would be)..
  97. I decide to ask for only $1-$5. This allows you to register any
  98. of the programs that Vortex may control/use.. and still AFFORD
  99. to send a contribution for Vortex.
  100.  
  101. Please consider the contribution!
  102.  
  103.  
  104.  =========================== AS-IS NOTICE ================================
  105.  
  106.  Vortex is released "AS-IS". I am NOT responsible for any damages
  107.  as the result of Vortex directly or indirectly. This means that
  108.  if you lose important data.. or your system blows up or something,
  109.  I am NOT responsible.
  110.  
  111.  Vortex works on my system. It SHOULD work on yours. You use this
  112.  program at your OWN risk.
  113.  
  114.  =========================================================================
  115.  
  116. System Requirements:
  117. ====================
  118.  
  119. - OS/WB 2.0+. Lower revisions may work... but you won't
  120.   have the ability to drag'n drop into the vortex window (you'll
  121.   be restricted to the file requester). This is also dependant
  122.   on the requirements of external utilities you may wish to use.
  123.  
  124. - At least 1 meg of RAM is recommended... it may work in 512k.. but
  125.   you probably won't be able to do much.
  126.  
  127. - For every feature of Vortex to be active.. you will need the
  128.   following utilities in your command path.
  129.  
  130.   - UUXT and companion UUSplit utilities (for encode/decode options)
  131.   - UUin (Encoder. Much faster and smaller than UUXT)
  132.   - UUout (decoder. Much faster than UUxt.)
  133.   - Lha, or Zip, or lzx or ALL THREE (for arc/unarc actions)
  134.   - Sploin (for split and join options)
  135.   - Vortex also relies on various DOS commands that should
  136.     already be in your path. (copy, delete, relabel, etc.)
  137.  
  138. Please see the special notes at the end of these docs regarding
  139. Encoders and decoders and compatibility.
  140.  
  141. INSTALLING VORTEX:
  142. ==================
  143.  
  144. Put Vortex and it's supporting files in the same directory.. which
  145. can be located anywhere you like. Any supported external utilities
  146. (lha, uuxt, etc.) should be in your command path (c:, etc.)
  147.  
  148. Vortex is distributed in TWO different forms:
  149.  
  150. - The file named "Vortex" is a stand-alone program.
  151.  
  152. - The file "Vortex.NEEDSLIB" is the SAME program but it will
  153.   require that you have the Cando.Library in your libs: drawer.
  154.  
  155. The difference is SIZE. If you already have the cando.library
  156. on your system... there's no need to use the stand-alone program
  157. (which is much larger). Simply rename The "NEEDSLIB" version to
  158. "vortex" and you're all set. The cando.library is copyrighted
  159. so you may not have it on your system. If you don't... use
  160. the stand-alone version.
  161.  
  162.   =======================================================================
  163.  
  164.                              INTRODUCTION:
  165.                              ~~~~~~~~~~~~ 
  166. Open a Vortex on your workbench screen and enter a new dimension
  167. in file handling. Split, Join, Encode, Decode, and manipulate/activate
  168. files (view,run,text, etc.) by dropping them into the Vortex. If you
  169. crave a more even handed or traditional approach to file selection..
  170. a file requester is only a mouse-click away.
  171.  
  172. There are 6 built-in modules. 5 of these are dedicated to specific
  173. tasks. Splitting, Joining, Encoding, Decoding and a DOS module. The 6th
  174. is a multi-purpose, configurable module called the "Action" module. It
  175. allows the user to create a wide range of actions specific to
  176. various file types.
  177.  
  178. Vortex offers a lot of different ways to accomplish tasks that would
  179. normally take you many steps via the CLI or via the use of
  180. separate programs. Vortex puts it all together in a nice GUI.
  181. Hopefully Vortex will incorporate an Arexx port in a
  182. future release.
  183.  
  184. Vortex relies on a few separate CLI based utilities (that must
  185. reside in your command path) to perform the "grunt" work for it's
  186. operations. If you don't already own the required programs you must
  187. obtain them via a shareware or p.d. source (BBS, Aminet, etc.). In
  188. many cases Vortex does not simply provide a GUI to these programs..
  189. it enhances their capabilities or adds extra options NOT available
  190. from the CLI.
  191.  
  192. I did not included the required CLI utilities within this archive
  193. because conflictions may occur with the distribution notices for
  194. each utility. You should have no problem obtaining them (you
  195. may already have them) and I have listed each required CLI program
  196. in the SYSTEM REQUIREMENTS section.
  197.  
  198. Brief Description:
  199. ------------------
  200.  
  201. Vortex is a GUI that links, controls and enhances several
  202. CLI based utilities designed for splitting, joining, encoding and
  203. decoding files. Vortex also features a customizable "action" mode
  204. that allows the program to perform a large assortment of actions via
  205. external utilities. Vortex can be used via "drag and drop file
  206. selection".... or has an easy to use file requester.
  207.  
  208. - If you send or receive UUencoded files... USE VORTEX!
  209. - If you need to split or join files... GIVE VORTEX A TRY!
  210. - If you need a simple "window on the workbench" to perform
  211.   various tasks quickly and easily.... TRY VORTEX!
  212.  
  213.  
  214.   ====================================================================
  215.  
  216.  
  217. The Basics:
  218. -----------
  219.  
  220. At first glance the small Vortex window may seem a bit short
  221. on features. Looks can deceive! The options available
  222. for each mode are selected via the OPS button and DRP button.
  223. Toggle through each available mode (via the roll-over button)
  224. and press the OPS button to get an idea of what Vortex can do!
  225. Click DRP to see what the "DROPtions" are (these determine
  226. how disks and directories are scanned.. and what happens when you
  227. drop files, drawers and disks into the Vortex). The Available DROPtion
  228. settings are the same for each mode.. but you can USE and SAVE a
  229. different set of droptions for EACH mode. Needless to say.. you can
  230. use and save OPTIONS for each mode as well. Each mode can also remember
  231. its last directory (optional).. so when you set a destination for
  232. SPLIT.. and then toggle to JOIN the old directory you set for JOIN
  233. will appear. You can of course turn that off if you'd like.
  234.  
  235.  
  236. ============================= >>MAIN<< ===================================
  237.  
  238.                           _  _   ___     _  
  239.                          | \/ | |___| | | \ |
  240.                          |    | |   | | |  \|
  241.  
  242.  
  243. The Main Vortex Window:
  244. -----------------------
  245.  
  246. - The List:
  247. -----------  
  248. This is the large blank area within the window, and this is where a
  249. list of selected files or dropped files will appear. Clicking twice
  250. on the name of any file in the list will delete the entry.
  251.  
  252. - OPS button:
  253. -------------
  254. Takes you to the options screen that is relevant to the
  255. mode you are in (split, join, encode, decode, or Action). This is
  256. where you set the options for the actions that will be
  257. performed.
  258.  
  259. - DRP button:
  260. -------------
  261. Takes you to the "DROPtions" screen for the
  262. relevant mode you are in. The screen allows you to configure such
  263. things as how Vortex scans disks and directories, and if Vortex
  264. wait for user input before performing an action. The DROPtions
  265. screen is the same for each mode... but you can have (use or save)
  266. a different set of DROPtions for EACH mode.
  267.  
  268. - DOS button:
  269. -------------
  270. This opens the Instant Action Window. Here you'll find various
  271. actions that you may find useful. They all occur instantly when
  272. you press the desired action button. For a more in-depth description,
  273. see "INSTANT ACTIONS".
  274.  
  275. - LOG button:
  276. -------------
  277. This brings up a window that allows you to load or save a log file.
  278. A log file is simply what is in the "List" window. It may be useful
  279. to use logs if you are performing the same actions over and over..
  280. or when rebuilding/joining files.
  281.  
  282. - ? button:
  283. -----------
  284. The required ABOUT window :)
  285.  
  286. - CLR button:
  287. -------------
  288. This clears the contents of the List.
  289.  
  290. - QV button:
  291. ------------
  292. This is "QuickView" mode. It takes all the files in the List and
  293. shows only the filename without the path. This mode is useful if
  294. you are displaying files that have a long path... and you need to
  295. quickly scan through the files. The button toggles between
  296. Standard View (whole path) and QuickView (filename only).
  297.  
  298. - ^? button:
  299. ------------
  300. You don't want to drop an icon on the window to list a file? This
  301. button brings up the file selection requester. In the requester you
  302. simply DOUBLE-CLICK on any file you want entered into the Vortex List,
  303. or use the ALL button on the requester to list all the files.
  304.  
  305. - ?> button:
  306. ------------
  307. You'll see this one on many of the Vortex sub-windows. This calls
  308. up a file requester. In this case its purpose is to set a destination
  309. directory. This is where the "end-result"... the "destination files"
  310. will be sent. Each mode can have its own destination directory.
  311.  
  312. The selected destination directory appears in the destination field.
  313.  
  314. - DESTINATION FIELD:
  315. --------------------
  316.  
  317. This is where your DESTINATION PATH appears.
  318.  
  319. [<] button: (DEST FIELD MEMORY option)
  320. ------------------------------------
  321. You'll notice that to the end of the Destination field there is
  322. a small button with the text "<". This toggles the field
  323. memory. Normally (when this button is NOT selected) Vortex
  324. will remember a specific Destination for each module. This means
  325. that if you set the SPLIT destination to "ram:" and then went
  326. to the JOIN module and set it to something else... and then
  327. CAME BACK to SPLIT... the destination of "ram:" would pop
  328. up again. 
  329.  
  330. Selecting this button will allow you to move from module to module
  331. without using the memory for the field... it will allow you
  332. to take whatever your current setting is with you as you scan
  333. through the modules.
  334.  
  335. NOTE: If you had earlier set the field to something and memory
  336. was on.. when you deselect the memory button the field will return
  337. to the last remembered setting.
  338.  
  339. - GO! button:
  340. -------------
  341. Tells Vortex to start executing the actions you have set-up for the
  342. mode you are in.
  343.  
  344. - TEMP WINDOW:
  345. --------------
  346. Some actions (such a "pre-archiving" in the encoder modules) will
  347. use a temporary directory to hold the archive. This is normally
  348. set to "t:".. if you'd like to change it.. hit the "F1" key on the
  349. keyboard and you'll get the TEMP window... set it, use it, save it,
  350. or abort it :)
  351.  
  352. ============================ >>DROPtions<< ===========================
  353.  
  354.            ___   ___   ___   ___  _____    ___         ___ 
  355.           |   \ |___) |   | |___)   |   | |   | |\  | |___
  356.           |___/ |   \ |___| |       |   | |___| | \_|  ___|
  357.  
  358.  
  359. Accessed through the [DRP] button on the main panel:
  360.  
  361. This is where you set the options that tell Vortex how to scan a
  362. DISK or DIRECTORY for files, if vortex should wait for user input
  363. before taking action.. and much more. 
  364.  
  365. The DISK functions effect what happens when a DISK is dropped on
  366. the Vortex window. The DIR options effect what happens when a DRAWER
  367. is dropped on the Vortex window.
  368.  
  369. DISK-FILESCAN:
  370. --------------
  371. This toggles between two modes. ROOT and RECURSIVE.
  372.  
  373. ROOT:
  374. -----
  375. This will only scan the ROOT directory of a disk.
  376. Vortex will not look into sub-directories.
  377.  
  378. RECURSIVE: 
  379. ----------
  380. Vortex will search the ROOT directory of a disk and
  381. it will also scan everything within all the sub-directories located
  382. on the disk. NOTE: large hard disk partitions with lots of
  383. sub-directories may take a quite a while to scan. 
  384.  
  385. DISK-FILELIST:
  386. --------------
  387. This toggles between two modes. ALL and SELECTIVE.
  388.  
  389. ALL:
  390. ----
  391. ALL files found in the scanned area of the disk will be listed.
  392. If your filescan was set to ROOT.. all files in the ROOT directory
  393. will be listed. If your filescan was set to RECURSIVE.. all the files
  394. found on the disk would be listed.
  395.  
  396. SELECTIVE:
  397. ----------
  398. This allows you to select which type of file(s) to look for.. or
  399. NOT look for. When this mode is selected it expects input in at
  400. least one the two available fields: MATCHING and EXCLUDING.
  401.  
  402. MATCHING: [         ]
  403. ---------------------
  404. This only works if your DISK-FILELIST is set to SELECTIVE and
  405. the MATCHING item is turned on (a check mark). You can choose
  406. to list/find only items matching your input in the field. This
  407. can be an extension... a filename.. etc.
  408.  
  409. To find only files ending in ".txt" you would enter ".txt" in the
  410. field (do not put the quotes). You can choose to match as many types
  411. of files as you want all at once.... just be sure you separate the
  412. text to match with a single space.
  413.  
  414. Example: To list/find all the files ending with ".pic" ".txt" ".jpg"
  415. and files with the name "SPACE" we would enter this into the field:
  416. ".txt .pic .jpg SPACE" (Again.. do not type the quotations). As
  417. you can see.. this allows you to match LOTS of files at once.
  418.  
  419. EXCLUDING: [         ]
  420. ----------------------
  421. This only works if your DISK-FILELIST is set to SELECTIVE and the
  422. EXCLUDING item is turned on (a checkmark). It allows you to EXCLUDE
  423. any type of file that matches your given text. It works the same
  424. way as MATCHING.. you can set this to as many types as you like
  425. ".info .doc .iff .lha HELLO" would exclude any file matching the
  426. given text. NOTE: EXCLUDE always has priority over MATCHING.. so if
  427. you have have ".txt" set in MATCHING and ".txt" set in excluding...
  428. ".txt" files will be EXCLUDED.
  429.  
  430. DIR-FILESCAN:
  431. DIR-FILELIST
  432. MATCHING [     ]
  433. EXCLUDING [      ]
  434.  
  435. These options work EXACTLY as the above DISK options.. only they
  436. effect how Vortex scans a DRAWER (or DRAWERS) when dropped on the
  437. window.
  438.  
  439. MATCH and EXCLUDE "SEARCH options":
  440. ===================================
  441.  
  442. There are three options available when scanning for a MATCH or
  443. an EXCLUDE. And these three options are available for both
  444. DISK and DIR scanning (you can keep a separate set of options
  445. for each).
  446.  
  447. Bring up the options window by clicking the DISK-FILELIST
  448. text or DIR-FILELIST text... (next to the "selective/all") Rollover
  449. button. (I ran out of room for buttons.. so I concealed it :) When
  450. you click the text the window will appear.
  451.  
  452. [] FILE AND PATH
  453. [] FILENAME ONLY
  454. [] CASE SENSITIVE
  455.  
  456. FILE AND PATH:
  457. --------------
  458. Vortex will match or exclude using the entire path as as comparison
  459. to your search input.
  460.  
  461. Example: You entered PIC in the MATCHING field: This would match
  462. everything in the BigPIC drawer. and any other drawer or file
  463. with the letters PIC in it. This allows you to match whole directories
  464. full of files at the same time you are matching specific filetypes.
  465.  
  466. FILENAME ONLY:
  467. --------------
  468. Only the contents of the FILENAME is compared to your search
  469. input.
  470.  
  471. CASE SENSITIVE:
  472. ---------------
  473. Any match or exclude must be of the same "case". For instance,
  474. if you input ".lha" this would not match files that contain
  475. ".LHA". "PIC" would not match "pic".. etc. Every match must be
  476. of the same CASE.
  477.  
  478. NOTE: For the casual user.. you'll probably never need to use
  479. these settings. A setting of "FILENAME ONLY" will do the trick.
  480. But if you're a power hungry match/exclude maniac.. you can
  481. use these :)
  482.  
  483. ANOTHER NOTE: The search options are not always 100% correct.
  484. Filenames and paths with spaces or strange characters MAY
  485. interfere with the matching/excluding process. Vortex will
  486. see these as word delimiters... and not make a match/exclude.
  487. I'm working on fixing this problem and making it 100%.
  488.  
  489. HELPER WINDOW:
  490. ==============
  491. A special "helper window" is available for all of the matching
  492. and excluding fields. Just click on the word "MATCHING:" or
  493. "EXCLUDING:" and the window will appear. This window uses a
  494. document (must be in the same dir as Vortex) called "VEXT.txt".
  495.  
  496. VEXT.txt is a plain ASCII document that can contain text that
  497. you match or exclude most often.. so you can save time typing
  498. the information in the fields. The document can be edited
  499. and saved directly from the helper window... or using your
  500. favorite ASCII editor. An example document is included.
  501.  
  502. CLEAR:
  503. ======
  504. To clear any field... simply click the [<|] button.
  505.  
  506.  
  507. WAIT FOR USER INPUT and AUTO GO!
  508. ================================
  509.  
  510. WAIT FOR USER INPUT:
  511. --------------------
  512. When you select to WAIT for input.. after you drop files on the
  513. window NOTHING will happen until you press GO!
  514.  
  515. AUTO-GO!:
  516. ---------
  517. When it is set to AUTO-GO! Whatever mode you are in will
  518. AUTOMATICALLY start when something is dropped on the
  519. Vortex... it's like pressing the go button right after
  520. dropping a file.
  521.  
  522. ADD/APPEND TO LIST ON DROP and MAKE NEW LIST ON DROP
  523. ====================================================
  524.  
  525. ADD/APPEND:
  526. -----------
  527. Anything you drop in the vortex will be ADDED onto the list
  528. of items you have already dropped.
  529.  
  530. MAKE NEW LIST ON DROP:
  531. ----------------------
  532. The items that are already in the list are cleared.. and the
  533. newly dropped items are placed in the list.
  534.  
  535. LIST .info OF DROPPED ICONS and  DON'T LIST .info of ICONS
  536. ==========================================================
  537.  
  538. LIST .info:
  539. -----------
  540. When you drop a DRAWER or a FILE... Vortex will see if there is
  541. an .info file available and include it in the list.
  542.  
  543. DON'T LIST:
  544. -----------
  545. Vortex will only list the DROPPED file name..  no info file.
  546.  
  547.  
  548.  ============================= >>SPLIT<< ==================================
  549.  
  550.                        ___  ___          _____
  551.                       |___ |___) |     |   |
  552.                        ___||     |___  |   |
  553.  
  554.  
  555. These are the options for file splitting when using the "split"
  556. module. They include:
  557.  
  558. Number of Splits:
  559. -----------------
  560. This Allows you to select the number of small "split-files"
  561. generated. Selecting 10 would slice a large file in the
  562. main window into 10 smaller files.
  563.  
  564. Bytes per split:
  565. ----------------
  566. This allows you to select the number of bytes per split file.
  567. For instance.. if you had a large file with a size of 10000
  568. and selected a bytes per split of 1000.. you would you would
  569. generate 10 split files at 1000 bytes each.
  570.  
  571. Number of Bytes:
  572. ----------------
  573. This option allows you to select a set number of bytes
  574. to split off from the main file. Using the "Starting offset"
  575. option you can select where in the file you wish to start
  576. splitting. The "save-rest" option allows you to save any
  577. un-used or left-over bytes to a specified file.
  578.  
  579. Example:
  580.  
  581. You're splitting a file named "BIGFILE" that is 20000 bytes large
  582. to the destination you set on the Vortex screen.. let's say it's
  583. "DH1:".
  584.  
  585. Number of Bytes: 5000
  586. Starting offset: 10000
  587. Save Rest: ram:
  588.  
  589. (each option must be turned on for it to function... a checkmark shows
  590. that the option is on).
  591.  
  592. The above would take 5000 bytes starting at the 10000 byte count
  593. and save it to "DH1:BIGFILE_BYT" and then save the rest (ending
  594. 5000) bytes to "ram:BIGFILE_RST".
  595.  
  596. Floppy:
  597. -------
  598. This option allows you to split a large file into several
  599. pieces directly onto floppy disk. The Flog option will
  600. create a LOG file (with a .FLOG extension) in RAM: which will
  601. contain a list of WHERE the split files went to. It may be useful
  602. to include the log with the split files if you distribute them to
  603. someone.. especially if they have Vortex. They can simply load
  604. the FLOG and rejoin the files. The rename option allows
  605. you to auto rename each disk to the "filename"||"SPLIT-NUMBER".
  606.  
  607. ASCII max lines:
  608. ----------------
  609. When using any of the other split options on an ASCII file..
  610. the splits don't care if they occur in the middle of a line
  611. or word.. etc. They are BINARY splitters. These options allow you
  612. to make splits by ASCII LINES or by ASCII BYTES.. and the program
  613. will make sure NEVER to split a LINE or WORD in half. This is useful
  614. if you want to send split text with no slashed words in it.
  615.  
  616. There is also a "1st Line" option... that allows you to
  617. set the first line of the... and it will automatically be followed
  618. by a blank line. This is very handy for those who use BBS systems
  619. that require an Inet e-mail address (TO: joe.shmoe@nowhere.net)
  620. as the first line and a blank line directly after. Now you can split
  621. large documents and automatically address them.. all at once.
  622.  
  623. NOTES: The ASCII MAX-Bytes function will try to get as close
  624. to the desired maximum amount as possible. It may slightly
  625. overstep the bounds. This happens because we are making
  626. sure not to split any lines.
  627.  
  628. Also, both of the ASCII split options are fairly slow (actually
  629. VERY slow) on large ASCII files. If you are interested in splitting
  630. encoded ascii files you should use the options in the encode module..
  631. you will see much faster execution. If you have a really fast
  632. machine.. it may not be too noticeable, but they ARE slow. I'll
  633. look into speeding these options up in a future release.
  634.  
  635.  
  636.  ============================= >>JOIN<< ===================================
  637.  
  638.                             ___ ___
  639.                              | |   | | |\  |
  640.                           |__| |___| | | \_|
  641.  
  642.  
  643. JOIN ALL TO ONE [         ]:
  644. ---------------------------------
  645.  
  646. This will join ALL files to the DESTINATION you set on the Vortex window
  647. as the FILENAME you enter into the available field on the JOIN
  648. window. "DESTINATION_FIELD/JOIN_filename".
  649.  
  650.  
  651. REBUILD SPLITS TO DEST:
  652. ----------------------
  653.  
  654. This will rebuild (take all the small sections of a split file and put
  655. them back together) ANY file that Vortex finds that ends with any of the following extensions: .1 .01 .001 _1 _01 _001 and the file must have more than one slice (there must be a .02 .002, etc.). The other sections must
  656. be in the same directory as the #1 extension. The files will all be
  657. rebuilt to the destination given in the Vortex destination field.
  658.  
  659. REBUILD SPLITS TO OWN:
  660. ----------------------
  661.  
  662. This does the same as the above.. only each split file is rebuilt to its own (current) directory (where the pieces were found).
  663.  
  664.  
  665.  ============================ >>UUencode<< =============================
  666.  
  667.                           ___        ___  ___   ___   ___
  668.              |   | |   | |___ |\  | |    |   | |   \ |___ 
  669.              |___| |___| |___ | \_| |___ |___| |___/ |___
  670.  
  671.  
  672. There are 2 "main" modes of operation:
  673.  
  674. - Encode to ONE
  675. - Encode to EACH
  676.  
  677. Encode to ONE: [        ]
  678. -------------------------
  679. This takes EACH file and encodes it into ONE file which will
  680. be located in your set destination on the Vortex window. The
  681. ONE encoded file will be named the "basename" you have entered
  682. in the available field and a ".uue" extension will be added.
  683. Remember: You don't need to put the ".uue" extension on your
  684. basename, Vortex will do that for you.
  685.  
  686. Encode to EACH:
  687. ---------------
  688. This takes EACH file and encodes it as a single file. This
  689. means that a file named "hello.pic" will become "hello.pic.uue".
  690. Each file will generate its own encoded counterpart located
  691. in your set destination on the Vortex window.
  692.  
  693. There are several options available to be used with the above
  694. modes:
  695.  
  696. Pre-Arc ALL: [       ]
  697. ----------------------
  698. This will only work with the Encode to ONE mode (doesn't
  699. make sense to use it on another mode). ALL files will
  700. be archived to ONE "temporary" file located in your given
  701. "TEMP:" directory. The file will be named the basename
  702. given in the available field and an ".lha", ".lzx" or ".zip"
  703. extension will be added (depending on which archiver you have
  704. selected to use). REMEMBER: You don't need to add the extension
  705. to your basename.. Vortex will do that for you. After the
  706. temporary file is created.. it is encoded into ONE file
  707. in your destination path given in the Vortex window. It
  708. will be named the basename given in the Encode ALL field
  709. and a ".uue" extension will be added. The temporary
  710. archive file will be deleted.
  711.  
  712. Pre-Arc EACH:
  713. -------------
  714. This works with Both modes. It takes EACH file and creates
  715. a single archive file in your given "TEMP:" directory. If
  716. you were using the Lha archiver... A file named "Hello.pic" would
  717. generate an archive named "Hello.pic.lha". Depending on
  718. which "MAIN" mode you have selected (Encode to ONE or Encode
  719. to EACH) the following will happen:
  720.  
  721. Encode to Each will take each archived file and generate an
  722. encoded file in your set destination on the Vortex window.
  723. The temporary archive files are deleted. The encoded files
  724. will take there name from the original files basename and
  725. a .uue extension will be added. A file named "hello.pic" would
  726. be archived (using lha) to "hello.pic.lha" and then the encoded
  727. file "hello.pic.uue" would be generated.
  728.  
  729. Encode to ONE will take each archived file and generate
  730. ONE encoded file in your set destination on the Vortex
  731. window. The file will be named using the basename given
  732. in the Encode to ONE field. A .uue extension will be added.
  733.  
  734. With .info:
  735. -----------
  736. If this option is set and the file we are archiving has an .info
  737. file.. it will be included in the archive.
  738.  
  739. MAX-Bytes:
  740. ----------
  741. Split the encoded file by a maximum number of bytes (entry is
  742. in "k").... 10 = 10000 bytes, 20 = 20000 byte, etc. Use the
  743. [<][>] gadgets to set this if you want.. clicking once moves
  744. forward one byte.. holding the gadgets down increases rapidly.
  745.  
  746. MAX-Lines:
  747. ----------------
  748. Same as the above.. but we this will split the file into
  749. a specified number of lines.
  750.  
  751. Pad: (UUXT only)
  752. ----------------
  753. This is a feature of UUXT... it will PAD spaces in the encoded
  754. file if you are having problems with the files in transit (see
  755. UUXT docs).
  756.  
  757. Buff: (UUin only)
  758. -----------------
  759. A feature of UUin... allows you to set your encoder buffer. Default
  760. is 32k... (a zero means to use a buffer the size of the input file).
  761. See UUin docs for more info.
  762.  
  763. RNM: (UUin only)
  764. ----------------
  765. A feature of UUin. UUin normally gives a single digit extension
  766. to split files (.1, .2, .3, etc.) and then RENAMES them as
  767. needed to .01, .001, etc. If you have a device that has problems
  768. with that (see the UUin docs).. then this will turn off the
  769. renaming.
  770.  
  771. 1st line:
  772. --------
  773. This allows you to add a first line to your encoded file (or
  774. each split file). Use the [<?] gadget to bring up the first
  775. line window.. which uses the "line.txt" document in your
  776. origin directory. It's a standard ascii file. The
  777. first line will have a blank line following it. This is
  778. useful to those who use a BBS that requires an Inet address
  779. on the first line.
  780.  
  781. # of # cut here:
  782. ----------------
  783. Two ways that this can work:
  784.  
  785. UUXT uses a program called UUsplit to split encoded files. The
  786. program automatically adds the "cut here" info. When this item
  787. is deselected... Vortex will REMOVE that information from each
  788. split file (it will also remove any occurrence of the word UUXT
  789. which is placed at the beginning and end of each file for
  790. no good reason. Having this feature OFF when using UUXT (Also
  791. when UUin is used with the Encode to One and a split option
  792. is on) will slow down the splitting... (because vortex must
  793. remove the text from each file). Having it on just leaves
  794. that info in the file.
  795.  
  796. UUin does not add this information.... so Vortex will do
  797. it for you if the item is selected.
  798.  
  799. ARC:
  800. ----
  801. Select your archiver (lha, zip, lzx). Must be in your path.
  802.  
  803. ENC:
  804. ----
  805. Select your encoder (UUXT, UUin) Must be in your path.
  806.  
  807. Your Temporary path should be set to anywhere that you have plenty
  808. of space. "T:" is always a good option if you have lots of ram.
  809. F1 from the main screen shows your TEMP path.
  810.  
  811. ============================= >>UUdecode<< ==============================
  812.  
  813.                          ___   ____  ___  ___   ___   ____
  814.             |   | |   | |   \ |____ |    |   | |   \ |____
  815.             |___| |___| |___/ |____ |___ |___| |___/ |____
  816.  
  817.  
  818. Not many options... but lots of power:
  819.  
  820. UNARC:
  821. ------
  822. After Your files are DECODED to your set destination the decoded
  823. files will be scanned to see if there are any archived files
  824. (.lha, .lzx, .zip). Any files that were ALREADY in your destination
  825. will be ignored. If archives are found... they will be UNARCHIVED
  826. to your destination.
  827.  
  828. DELETE ARC:
  829. -----------
  830. If this option is selected.. and UNARC is executed (an archive
  831. is found and extracted).. the archive file itself will be deleted
  832. after the extract.
  833.  
  834. ACTION ALL DECODED FILES:
  835. -------------------------
  836. After the files have been decoded... they will be sent to
  837. your action module. IF you have some actions set for various
  838. file types and those types are found in the decoded files..
  839. they will be ACTIONED.
  840.  
  841. MATCHING:
  842. ---------
  843. Only decoded files matching your given text will be sent to the
  844. action module.
  845.  
  846. Example:
  847.  
  848. You have an encoded file called "Pictures.uue". It contains
  849. an archive of 6 .jpg pictures. You have a .jpg action set up
  850. in your action module (a viewer). You have UNARC, DELETE ARC,
  851. and MATCHING ".jpg" selected in the decode screen:
  852.  
  853. When you drop the encode file on the vortex screen (or a disk
  854. or DIR containing the file) it will be decoded... unarced (the
  855. arc will be deleted).. and then each picture will be sent
  856. to your action module and shown.
  857.  
  858. Pretty handy eh?
  859.  
  860. CONTENTS:
  861. ---------
  862. This nifty option will scan through all .uue files (even splits)
  863. and list there contents. If the SIZE option is also selected each
  864. internal file's size will also be listed.
  865.  
  866. NOTE: The SIZE option may not work on ALL uuencoded files.. 
  867. (especially those that don't HAVE a size listing in them :)
  868. If you get strange characters or an incorrect listing with
  869. the SIZE option ON... turn it off and see if that helps.
  870.  
  871.  
  872. Decoder:
  873. --------
  874. Select between UUXT or UUout as your decoder.
  875.  
  876. BUFFER:
  877. -------
  878. Only works with UUout.. allows you to set your buffer size.
  879.  
  880. FILES ONLY:
  881. -----------
  882. Only works with UUout.. tells UUout to ignore the PATHS in the
  883. encoded files and not to create the path during the decode.
  884.  
  885.  
  886. ========================= >>INSTANT_ACTIONS<< ===========================
  887.  
  888. Click on the [DOS] button to bring these up. These are different
  889. from all the other OPTIONS. These are INSTANT actions... NOT
  890. options. This window allows you to instantly USE these commands
  891. on whatever is listed in the Vortex window. I hope to add complete
  892. option "modules" for many of these commands in the future... until
  893. then I decide to toss this window in as a bonus. 
  894.  
  895. NOTE: most of these COMMANDS have a "matching" field to the
  896. right of the command. This allows you to specify to perform the action
  897. only on a file in the list MATCHING your search criteria. 
  898.  
  899. The HELPER window is available by using the [?] button. The helper
  900. window can hold commonly used search/match extensions.. etc. and
  901. saves you from typing. The window uses a plain ASCII document that
  902. must reside in the same directory as Vortex.. and it must be named
  903. "VEXT.txt". It can be edited using any ascii editor or even within
  904. the helper window itself.
  905.  
  906. COPY:
  907. -----
  908. This will COPY all the files in the list to your destination.. or
  909. only files in the list MATCHING what you enter in the "matching field"
  910. to the right (which must be turned on.. "CHECK MARK").
  911.  
  912. DELETE:
  913. -------
  914. This will DELETE all the files in the list to your destination.. or
  915. only files in the list MATCHING what you enter in the "matching field"
  916. to the right (which must be turned on.. "CHECK MARK").
  917.  
  918. MOVE:
  919. -----
  920. This will copy all the files in the list to your destination.. or
  921. only files in the list MATCHING what you enter in the "matching field"
  922. to the right (which must be turned on.. "CHECK MARK").. and then
  923. delete the original file.
  924.  
  925. LHAeach:
  926. --------
  927. This will LHA archive EACH file in the list to your destination.. or
  928. only files in the list MATCHING what you enter in the "matching field"
  929. to the right (which must be turned on.. "CHECK MARK"). Each file
  930. will result in a separate archive with the files' basename and
  931. a .lha extension.
  932.  
  933. ZIPeach:
  934. --------
  935. Same as the above... but with ZIP compression.
  936.  
  937. LHAone:
  938. -------
  939.  
  940. This will LHA archive all the files in the list or only files in the
  941. list MATCHING what you enter in the "matching field" to the FAR right (which must be turned on.. "CHECK MARK")... to ONE file in your
  942. set destination. The destination archive will take it's name
  943. from the given BASENAME in the field to the right of the button.
  944. DO NOT PLACE and .lha EXTENSION on the name. Vortex will do that
  945. for you.
  946.  
  947. ZIPone:
  948. -------
  949. same as the above.. but with ZIP compression.
  950.  
  951. LHA EXRACT , ZIP EXTRACT, LZX EXTRACT:
  952. --------------------------------------
  953. Looks for .lha, .zip, or .lzx files and extracts them to your
  954. set destination.
  955.  
  956. AddLine:
  957. --------
  958. Adds the line set in the available field to the TOP of every ASCII
  959. file found in the list. The line is followed by one blank line.
  960. Usefull for addressing multiple text files with Internet addresses
  961. (for those who use a BBS that requires the address on the first line
  962. followed by a blank space).
  963.  
  964.  
  965. ============================== >>ACTION<< ===============================
  966.   
  967.                      ___   ___ _____    ___    
  968.                     |___| |      |   | |   | |\  |
  969.                     |   | |___   |   | |___| | \_|
  970.  
  971.  
  972. The ACTION MODULE:
  973. ------------------
  974.  
  975. This is an interesting place. You can do all sorts of things.
  976. You can create actions that you can turn on and off with a mouse
  977. click. The actions can be DOS commands.. or a VORTEX command
  978. or combinations of both.
  979.  
  980. Looking at the main \\//ortex //\\action ||=ditor window, you'll
  981. see a large "list" area and below are several fields (labeled
  982. "DOS:", and one is labeled "Vortex:". This is where you tell
  983. Vortex WHAT to do with a file MATCHING your search criteria (the
  984. EXT: field).
  985.  
  986. Before explaining the details of this screen... I'll tell you exactly
  987. WHAT happens with the data that you enter:
  988.  
  989. Think of the large section at the top of the screen as an ACTION
  990. list. You'll be entering data in the below fields that will construct the list. The list tells vortex to "DO THIS" when you "FIND
  991. THAT". This means that Vortex will look for files matching an extension
  992. you have given or matching the text within the file name itself... and
  993. if it is found, Vortex will take an action.
  994.  
  995. Vortex will proceed from the top of the list to the bottom. Each
  996. entry in the list can have 3 full actions (1 Vortex action and 2
  997. DOS actions). The actions can be moved, copied, and turned ON or OFF.
  998. When off, vortex will NOT perform an action on files matching the text
  999. you have entered in the "EXT:" field.
  1000.  
  1001. EXAMPLE of what this allows you to do:
  1002.  
  1003. You could set up an action for the program "superview" to show all
  1004. files containing the extension .pic. Now, you could simply drop
  1005. a disk or directory into the vortex and show every .pic file like
  1006. a slide show.
  1007.  
  1008. The power can be much greater than that. You could set up multiple
  1009. actions for the same filetype to occur in a set order. This allows
  1010. you to perform complex tasks all at once.
  1011.  
  1012. Now let's take a look at WHERE and HOW you enter the info that tells
  1013. Vortex what to do:
  1014.  
  1015. Think of the DOS fields as a CLI or SHELL. Anything you can do from
  1016. the CLI or SHELL can be put in these fields. The only difference
  1017. is that these fields can use 4 additional commands:
  1018.  
  1019. FILE, BASENAME, BASEX, and DEST.
  1020.  
  1021. FILE = The full path/file that we are working on.
  1022. BASENAME = The filename only (without the path)
  1023. BASEX = The filename only... without an extension if it had one.
  1024. DEST = The destination we have set in the Vortex destination field.
  1025.  
  1026. EXAMPLE:
  1027.  
  1028. We set the EXT field to .txt and dropped the file Dh1:hello.txt
  1029. on the vortex. Vortex would then interpret the commands like this:
  1030.  
  1031. FILE = DH1:Hello.txt
  1032. BASENAME = Hello.txt
  1033. BASEX = Hello
  1034. DEST = (whatever you have set in your Vortex Destination Field)
  1035.  
  1036. These commands must always be used in UPPERCASE.
  1037.  
  1038. If you are familiar with using a CLI or Shell.. even for the
  1039. most simple tasks, you will find the Vortex DOS fields very
  1040. simple to use. In fact, the V.A.E. commands will make things
  1041. VERY EASY for you.
  1042.  
  1043. - The "EXT:" field
  1044.  
  1045.   This is where you place the EXTENSIONS you wish to match (the
  1046.   types of files you want an action to happen to). You can put
  1047.   as many as you like.. the only limit is a 256 character maximum
  1048.   in the field. Each extension MUST be separated by a space.
  1049.   You can ALSO match portions of a FILENAME.. so you are not
  1050.   simply limited to an EXTENSION match.
  1051.  
  1052.   EXAMPLE: .txt .pic .doc SPACE HELLO
  1053.  
  1054.   The "case" (capital or lowercase) does not matter. Any extension
  1055.   matching each WORD above will trigger your action.
  1056.  
  1057. This would match all files with a .txt .pic or .doc extension...
  1058. and any files with the words SPACE or HELLO in them.
  1059.  
  1060. - "DOS:" fields
  1061.  
  1062.   The TOP DOS: field is DOS #1. It goes first.. before DOS #2 :)
  1063.   When a file is found that matches one of the given extensions
  1064.   this field is executed. Just think of this as a CLI or SHELL.
  1065.   With a little more control... as you'll soon see.
  1066.  
  1067.   Each DOS field can understand the 4 mentioned commands. DEST,
  1068.   FILE, BASENAME, and BASEX. They MUST be in CAPITAL letters.
  1069.   
  1070.   Each DOS field can be executed on a PER FILE basis or ONCE
  1071.   (only when a matching file is found for the first time). When
  1072.   a DOS field is set to ONCE... it will not understand the V.A.C.
  1073.   FILE commands (since we are only executing ONCE when ANY matching
  1074.   file is found.. we are not concerned with WHICH file was found).
  1075.   
  1076.   Preceding each DOS field is the STACK field. If a cli program
  1077.   you are executing needs a specific stack size, you can set it
  1078.   here. The stack size is automatically set to 4096 for each
  1079.   program unless you enter and USE/SAVE another amount. Most
  1080.   programs probably won't care much about the stack... but
  1081.   if they do.. here's where you set it :)
  1082.  
  1083. Let's say you dropped a disk on the Vortex set to ACTION mode
  1084. with a destination of "ram disk/t:". The disk "Droptions" (DRP)
  1085. were set to "ROOT"/"ALL".. so everything in the root directory
  1086. will be scanned.
  1087.  
  1088. Now, Vortex checks the FIRST entry in your ACTION list... (if
  1089. there is one). Let's say you have only ONE entry for the extension
  1090. ".pic". Vortex will then scan all the files we found in the root
  1091. directory of the dropped disk for any ".pic" extensions. If we
  1092. found any we will execute the given DOS commands (if any). If
  1093. the DOS command is a PER-FILE command (ONCE is not selected)
  1094. the DOS commands will be executed for EACH matching file. If
  1095. the DOS command is a ONCE command (ONCE is selected).. the DOS
  1096. command will execute only ONCE if ANY matching files are found.
  1097. here are some examples....
  1098.  
  1099. A command to simply show the picture using an external utility
  1100. such as "superview" could be achieved with the command:
  1101.  
  1102. superview FILE
  1103.  
  1104. That's it. Everything matching the given extension (or extensions)
  1105. would be sent to superview.
  1106.  
  1107. To copy all the matching files to the set destination...
  1108.  
  1109. copy FILE DEST
  1110.  
  1111. To Archive each file into it's own archive (an archive with the
  1112. files basename) to your set destination....
  1113.  
  1114. lha a DESTBASENAME.lha FILE
  1115.  
  1116. If we wanted to archive each file into ONE archive with the name
  1117. TEST.lha....
  1118.  
  1119. lha a DESTtest.lha FILE
  1120.  
  1121. Getting the idea?
  1122.  
  1123. Here's an example of how a ONCE action works:
  1124.  
  1125. EXT: .pic
  1126.  
  1127. DOS: lha a "DESTtest.lha" "FILE"
  1128. DOS: UUin "DESTtest.lha" "DESTtest.uue" (ONCE)
  1129.  
  1130. The above example would archive EACH .pic file into DEST/test.lha
  1131. (DEST is whatever you set in the vortex destination field). Then
  1132. after performing lha on EACH file.. it will activate UUin ONCE
  1133. and encode the lha file created in DEST.. creating DEST/test.uue.
  1134.  
  1135. If we did not set the ONCE option for UUIN on the DOS2 field..
  1136. UUIN would have been executed on/for EACH file we found. The
  1137. ONCE option tells Vortex to perform the action ONCE when the
  1138. filetype (or whatever you typed into the EXT field) is found.
  1139. Not on a per file basis. Remember... BASENAME, BASEX and FILE do
  1140. not work with the ONCE option since it is not concerned with a
  1141. single file.
  1142.  
  1143. Just remember:
  1144.   
  1145. FILE: interpreted as the file we have found (a file matching the EXT
  1146. and dropped on the Vortex as a file.. within a disk or a drawer). The
  1147. WHOLE PATH and FILENAME.
  1148.  
  1149. BASENAME: interpreted always inerpreted the basename of that file.
  1150.  
  1151. BASEX: interpreted as the basename with the extension removed (if it
  1152. had one).
  1153.  
  1154. DEST: interpreted as your set destination in the Vortex
  1155. destination field for the ACTION module.
  1156.  
  1157. Once you get comfortable using the V.A.C. commands within
  1158. your regular DOS commands... you'll see that you can perform
  1159. anything that you could do from a CLI or SHELL -but- you can
  1160. manipulate the data coming in from Vortex WITHIN the dos
  1161. command line.
  1162.  
  1163. IMPORTANT:
  1164.  
  1165. Notice how we type the V.A.C. commands. DESTBASENAME (both commands
  1166. placed TOGETHER... this is because we are saying "ram:t/basename"..
  1167. etc. When you are combining DEST with a filename.. they must
  1168. be connected.. because they are a PATH and a FILENAME.
  1169.  
  1170. DESTBASENAME
  1171. DESTBASEX
  1172. t:BASENAME
  1173. t:BASEX
  1174. DESTtest.file
  1175.  
  1176. Get it?
  1177.  
  1178.  
  1179. MORE POWER!
  1180.  
  1181. I made TWO DOS actions available PER "EXT" entry... but you can
  1182. extend actions out over several entries if you wish. For instance
  1183. you can perform 10 actions on files matching ".pic".. by making 5
  1184. entries (2 commands each). You could view the pictures, pack them,
  1185. encode them, split them, and anything else you could do
  1186. from the CLI.. but here it will always be done
  1187. automatically and in the order it appears in your Action Editor
  1188. List). You can turn off entries, delete entries, copy them, etc..
  1189. this allows you to make changes easily and quickly to your
  1190. configuration. You could set up all of the above actions.. and then
  1191. decide you don't need the "splitting".. so you just turn that entry
  1192. off... bingo. When you need it again, just turn it on. You need
  1193. it to happen BEFORE another command... just move it or copy it to
  1194. where you need it.
  1195.  
  1196. More examples:
  1197.  
  1198. Let's say we want to Archive all the .txt files dropped on the
  1199. Vortex window to ONE file in the vortex destination.
  1200.  
  1201. lha a DESTtestfile.lha FILE
  1202.  
  1203. This would create a file in the set destination called "testfile.lha"
  1204. and it would contain all the dropped .txt files.
  1205.  
  1206. Let's say we want to Archive all the .txt files dropped on the
  1207. Vortex window as a single archive each.. to the set destination
  1208. taking each name from the filename (leaving the .txt extension).
  1209.  
  1210. lha a DESTBASENAME.lha FILE
  1211.  
  1212. This would create an archive of each .txt file using the basename
  1213. and adding an .lha extension onto it. If you dropped a file called
  1214. test.txt you would create test.txt.lha.
  1215.  
  1216. Let's say you wanted the same as the above but without the .txt
  1217. extension.
  1218.  
  1219. lha a DESTBASEX.lha FILE
  1220.  
  1221. This would create the same as the above without the .txt extension
  1222. included in the resulting file. test.lha.
  1223.  
  1224. ----
  1225.  
  1226. The VORTEX option:
  1227. ==================
  1228.  
  1229. The Vortex option (if selected) is performed before DOS1 and DOS2.
  1230. All matching files will be sent to the Vortex module you have selected.
  1231. The setting in that module will be used on each file.
  1232.  
  1233. At the moment the the "FLOPPY" option in the split module does not
  1234. work correctly with the Vortex option in the Action Editor.. all
  1235. other vortex module options work properly.
  1236.  
  1237. Using the Vortex option WITH the DOS options can be very powerful.
  1238. You can Send all ".pic" files to Vortex split.. and then perform
  1239. a few DOS actions on them with your DOS fields.
  1240.  
  1241. The Controls:
  1242. =============
  1243.  
  1244. ADD:
  1245. ----
  1246. Adds whatever you have typed into the field to the ACTION list
  1247. as a new entry at the end of the list.
  1248.  
  1249. INSERT:
  1250. -------
  1251. Adds whatever you have typed into the fields to the ACTION list
  1252. and inserts it before the current listing.
  1253.  
  1254. ^^:
  1255. ---
  1256. UPdates the listing you are working on. If you made changes..
  1257. hit this and they will go into the list.
  1258.  
  1259. QIK:
  1260. ----
  1261. When this button is ON (pushed in) the changes you make will
  1262. automatically go into the ACTION list when you hit return
  1263. from within a field or turn a button on.. etc. It's like
  1264. having the ^^ button on all the time.
  1265.  
  1266. Copy:
  1267. -----
  1268. Click on an item from the list, select the copy button and
  1269. you can copy that item to wherever you next click in the list.
  1270. The item will be added BEFORE the entry you click on.
  1271.  
  1272. Move:
  1273. -----
  1274. Same as the above.. but deletes the old entry after copying
  1275. it.
  1276.  
  1277. Delete:
  1278. -------
  1279. Click on an entry in the list and then hit this button to
  1280. delete it.
  1281.  
  1282. |<<
  1283. ----
  1284. Go the the first entry
  1285.  
  1286. >>]
  1287. ----
  1288. Go to the last entry
  1289.  
  1290. > = NEXT entry.
  1291.  
  1292. < = Prev entry.
  1293.  
  1294. FIELDS:
  1295. -------
  1296. The two fields show you the item number you are working on in the
  1297. list, and the total number of action items in the list.
  1298.  
  1299. NOTES:
  1300.  
  1301. * You can select any item in the list by clicking on it.
  1302.  
  1303. * You can turn an item on or off by double clicking on it.
  1304.  
  1305. * If you have entered an item in the dos field that may be
  1306.   using a path with spaces in it or a file name with spaces in
  1307.   it.. use quotes.. just like you would from the CLI. Example:
  1308.  
  1309.   Superview "FILE"
  1310.  
  1311.  
  1312. You can create some fairly powerful scripts in the action editor.
  1313. Just get used to the commands and how they work.. and you'll
  1314. be on your way! If all you need is simple "If -THIS- then -THAT-
  1315. actions... all you do is enter an EXT, and create a DOS or VORTEX
  1316. entry of what you want to happen (per file or once).
  1317.  
  1318. EXT: .pic
  1319.  
  1320. DOS: SuperView FILE
  1321.  
  1322. -------
  1323.  
  1324. EXT: .lha .lzh .lz
  1325.  
  1326. DOS: lha x FILE DEST
  1327.  
  1328. -------
  1329.  
  1330. Whew! I'm almost done typing! FINALLY!
  1331.  
  1332. CONFIGUARTION:
  1333. --------------
  1334.  
  1335. Throughout Vortex you'll see the buttons USE SAVE and ABORT.
  1336. If you select to SAVE any of your settings.. Vortex will create
  1337. a file called Vortex.cfg in the directory in which Vortex
  1338. resides. From now on it will use those settings when the
  1339. program is started.
  1340.  
  1341. Vortex is not distributed with a Vortex.cfg file... because
  1342. it will automatically switch to default settings when such a
  1343. file is not found. The file is only needed if you are saving
  1344. your own settings.
  1345.  
  1346. The Line.txt document is an ascii file that contain lines that
  1347. you want to use with the first line gadget.
  1348.  
  1349. The VEXT.txt document is an ascii file that can contain extensions
  1350. or other words that you match on a regular basis.
  1351.  
  1352. You can save a different set of DROPtions for each mode.
  1353.  
  1354. A GENERAL Encoding/Decoding TIP and a word about compatibility:
  1355. ===============================================================
  1356.  
  1357. Before sending someone an encoded file.. try decoding it yourself.
  1358. make sure it turned out o.k. on your end first. Sometimes an
  1359. encoder (uuin/uuxt) will make an error durring the decode...
  1360. and if you try it again.. it will work correctly. Why? You got me.
  1361.  
  1362. When an encoded file gets picked up from a newsgroup or has
  1363. been mixed in with other files or text... it can have all kinds of
  1364. extra garbage in it not belonging to the encoded file. Sometimes
  1365. this makes it hard for the decoder to work properly... that's the
  1366. decoders problem.. not VORTEX's.
  1367.  
  1368. Sometimes UUout will decode a file that UUxt won't and sometimes
  1369. UUXT will decode a file that UUout won't. If you aren't successful
  1370. with one.. try the other.
  1371.  
  1372. Also.. wherever possible (archivers or encoders/decoders) you
  1373. should make them resident (if they can be made resident).. this
  1374. will speed up all actions. (when an archiver is adding a file
  1375. at a time to a large archive.. etc). If I can't get the "chunk"
  1376. method working (see "things to do" below) I may just auto-resident
  1377. and then auto-remove each program as needed.. allowing for a
  1378. speed up.
  1379.  
  1380. In the Words of Han Solo.... "It's not my fault!"
  1381.  
  1382. ----------------------
  1383. THINGS I'D LIKE TO DO:
  1384. ----------------------
  1385.  
  1386. Arexx port? I don't know if I can find the time.. but we'll see.
  1387.  
  1388. Add a module specific to Archivers.
  1389.  
  1390. Add modules specific to other programs (MIME encoders/decoders, etc.)
  1391.  
  1392. Add support for more archivers: The ones I'm working on now are:
  1393. GZIP and GNUtar. (.gz .tar). Let me know if you need one.
  1394.  
  1395. Add some "smart" code to check how many file you are working
  1396. on... and see if we are allowed to put them in a row THROUGH the
  1397. archiver/encoder we are using. This will cause a great speed increase
  1398. (see how fast LHA is when adding files to one?.. that's because it's
  1399. using a "list" as input... and a list can have LOTS of files.
  1400. Some programs do not except input from a list.. and there is
  1401. a restriction on how many files we can send to them AT ONCE
  1402. on a command line. So right now.. those files are sent one
  1403. at a time.. so we don't have an overflow problem. That means
  1404. that the program being executed must "reload" itself each time
  1405. .. which slows things down some). I'll get around this in the
  1406. next release by sending files in CHUNKS. and you'll see a speed
  1407. increase in Archivers and Encoders!
  1408.  
  1409. Add "Case Sensitive", "PATH and FILE", and "FILEONLY" options
  1410. to -ALL- searches in Vortex (the action window does not have this
  1411. at the moment.. it searches for a match on a PER LINE basis (PATH
  1412. and/or FILENAME).
  1413.  
  1414. More Custom COMMANDS for the DOS fields?
  1415.  
  1416. Add user-function keys and keyboard shortcuts.
  1417.  
  1418. Add the ability to ACTION single files in the list by selecting
  1419. them and pressing a key.
  1420.  
  1421. Have the program "adjust" to a high-res interlace screen. If
  1422. you use such a screen you'll probably notice that the windows
  1423. all seem squished.. that's because Vortex was designed on
  1424. a low-res screen and cannot auto-resize itself. This is going
  1425. to be lots of work... so I won't do it unless I see there
  1426. are people who want it. It doesn't really look TOO bad on
  1427. a high-res interlace screen, just squashed :)
  1428.  
  1429. Fix the floppy split option to work within the Action Module.
  1430.  
  1431. Add some way of STOPPING an action after it has started.. in
  1432. case you didn't mean to do it.
  1433.  
  1434. More error detection stuff... right now we are getting by on
  1435. the minimum. If the program simply shutsdown.. that means
  1436. you hit an error without error code to take care of it. I'll
  1437. need to know what you were doing when it happened to fix
  1438. it. I -HOPE- I already got all of the areas that could cause
  1439. this.
  1440.  
  1441. After I clean-up the code.. and add a bunch of notes to it..
  1442. I'll release it. Watch for a nice archive full of SOURCE CODE
  1443. to appear soon.
  1444.  
  1445. Welp, that's it... now I think I can rest my eye's and stop
  1446. thinking in CODE :)
  1447.  
  1448.    // 
  1449. \\//AMIGA FOREVER!
  1450.  
  1451. Joey McDonald
  1452.  
  1453.  
  1454.